MongoDB Atlas Administration API (1.0)

Download OpenAPI specification:Download

The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.

Access Tracking

Returns access logs for authentication attempts made to MongoDB Cloud database deployments.

Alert Configurations

Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Alerts

Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Auditing

Returns and edits database auditing settings for MongoDB Cloud projects.

Cloud Backups

Returns, takes, edits, and removes Cloud Backup snapshots.

Cloud Backup Export

Returns, adds, and removes Cloud Backup snapshot export buckets. Also returns and adds Cloud Backup export jobs.

Cloud Backup Restore Jobs

Returns, starts, and cancels Cloud Backup restore jobs.

Cloud Backup Schedule

Returns, edits, and removes Cloud Backup schedules.

Cloud Migration Service

Manages the Cloud Migration Service.

Cloud Provider Access

Returns, adds, authorizes, and removes AWS IAM roles in Atlas.

Clusters

Returns, adds, edits, and removes database deployments.

Custom DNS for Atlas Clusters Deployed to AWS

Returns and edits custom DNS configurations for Atlas database deployments on AWS.

Custom Database Roles

Returns, adds, edits, and removes custom database user privilege roles.

Database Users

Returns, adds, edits, and removes database users.

Data Federation

Returns, adds, edits, and removes Federated Database Instances.

Data Federation Private Networks

Returns, adds, and removes all private endpoints for Federated Database Instances and Online Archives in the specified project.

Data Lake Pipelines

Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.

Encryption at Rest using Customer Key Management

Returns and edits the Encryption at Rest using Customer Key Management configuration.

Events

Returns events. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.

Federated Authentication

Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.

Global Clusters

Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.

Invoices

Returns invoices.

LDAP Configuration

Returns, edits, verifies, and removes LDAP configurations.

Legacy Backup Snapshots

Returns, removes, and edits the expiration date of Legacy Backup snapshots.

Example resource info for versioning of the Atlas API

Returns some text dummy data for test purposes.

Authorizations:
DigestAuth
query Parameters
envelope
boolean
Default: false
Example: envelope=false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

Responses

Response samples

Content type
application/vnd.atlas.2021-03-03+json

Legacy Backup Restore Jobs

Returns and adds restore jobs for database deployments that use Legacy Backups.

Legacy Backup Checkpoints

Returns Legacy Backup Checkpoint metadata. Checkpoints serve as additional restore points for sharded clusters at points in time between regular snapshots.

Legacy Backup Snapshot Schedule

Returns and edits Legacy Backup snapshot schedules.

Maintenance Windows

Returns, edits, and removes maintenance windows.

MongoDB Cloud Users

Returns, adds, and edits MongoDB Cloud users.

Monitoring and Logs

Returns database deployment monitoring and logging data.

Multi-Cloud Clusters

Returns, adds, edits, or removes multi-cloud clusters.

Network Peering

Returns, adds, edits, and removes network peering containers and peering connections.

Network Peering Connections

Returns, adds, edits, and removes network peering connections.

Network Peering Containers

Returns, adds, edits, and removes network peering containers.

Online Archive

Returns, adds, edits, or removes an online archive.

Organizations

Returns, adds, and edits organizational units in MongoDB Cloud.

Performance Advisor

Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds.

Private Endpoint Services

Returns, adds, edits, and removes private endpoint services.

Programmatic API Keys

Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.

Project IP Access List

Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.

Projects

Returns, adds, and edits collections of clusters and users in MongoDB Cloud.

Rolling Index

Creates one index to a database deployment in a rolling manner.

Root

Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.

Serverless Instances

Returns, adds, edits, and removes serverless instances.

Serverless Private Endpoints

Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.

Shared-Tier Restore Jobs

Returns and adds restore jobs for shared-tier database deployments.

Shared-Tier Snapshots

Returns and requests to download shared-tier database deployment snapshots.

Teams

Returns, adds, edits, or removes teams.

Third-Party Service Integrations

Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.

X.509 Authentication for Database Users

Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.